/
DataServiceQuery`1.xml
465 lines (439 loc) · 31.1 KB
/
DataServiceQuery`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
<Type Name="DataServiceQuery<TElement>" FullName="System.Data.Services.Client.DataServiceQuery<TElement>">
<TypeSignature Language="C#" Value="public class DataServiceQuery<TElement> : System.Data.Services.Client.DataServiceQuery, System.Collections.Generic.IEnumerable<TElement>, System.Linq.IQueryable<TElement>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataServiceQuery`1<TElement> extends System.Data.Services.Client.DataServiceQuery implements class System.Collections.Generic.IEnumerable`1<!TElement>, class System.Collections.IEnumerable, class System.Linq.IQueryable, class System.Linq.IQueryable`1<!TElement>" />
<TypeSignature Language="DocId" Value="T:System.Data.Services.Client.DataServiceQuery`1" />
<TypeSignature Language="VB.NET" Value="Public Class DataServiceQuery(Of TElement)
Inherits DataServiceQuery
Implements IEnumerable(Of TElement), IQueryable(Of TElement)" />
<TypeSignature Language="F#" Value="type DataServiceQuery<'Element> = class
 inherit DataServiceQuery
 interface IQueryable<'Element>
 interface seq<'Element>
 interface IQueryable
 interface IEnumerable" FrameworkAlternate="netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2" />
<TypeSignature Language="C++ CLI" Value="generic <typename TElement>
public ref class DataServiceQuery : System::Data::Services::Client::DataServiceQuery, System::Collections::Generic::IEnumerable<TElement>, System::Linq::IQueryable<TElement>" />
<TypeSignature Language="F#" Value="type DataServiceQuery<'Element> = class
 inherit DataServiceQuery
 interface IQueryable<'Element>
 interface seq<'Element>
 interface IEnumerable
 interface IQueryable" FrameworkAlternate="netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TElement" />
</TypeParameters>
<Base>
<BaseTypeName>System.Data.Services.Client.DataServiceQuery</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<TElement></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Linq.IQueryable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Linq.IQueryable<TElement></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TElement">Type of results returned by the query.</typeparam>
<summary>Represents a single query request to a data service.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
No public constructors are defined on this class. Object instances are created by using <xref:System.Data.Services.Client.DataServiceContext.CreateQuery%2A> or <xref:System.Data.Services.Client.DataServiceContext.CreateQuery%2A> on the <xref:System.Data.Services.Client.DataServiceContext> class.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="AddQueryOption">
<MemberSignature Language="C#" Value="public System.Data.Services.Client.DataServiceQuery<TElement> AddQueryOption (string name, object value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Data.Services.Client.DataServiceQuery`1<!TElement> AddQueryOption(string name, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.AddQueryOption(System.String,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function AddQueryOption (name As String, value As Object) As DataServiceQuery(Of TElement)" />
<MemberSignature Language="F#" Value="member this.AddQueryOption : string * obj -> System.Data.Services.Client.DataServiceQuery<'Element>" Usage="dataServiceQuery.AddQueryOption (name, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Data::Services::Client::DataServiceQuery<TElement> ^ AddQueryOption(System::String ^ name, System::Object ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Services.Client.DataServiceQuery<TElement></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="name">The string value that contains the name of the query string option to add.</param>
<param name="value">The object that contains the value of the query string option.</param>
<summary>Creates a new <see cref="T:System.Data.Services.Client.DataServiceQuery`1" /> with the query option set in the URI generated by the returned query.</summary>
<returns>A new query that includes the requested query option appended to the URI of the supplied query.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The query options are added to the resultant URI using `?name=value&name2=value2`… syntax where the name maps directly to the `name` parameter and the `value` is obtained by calling ToString on the `value` parameter. The `name` starts with `$`.
Non-WCF Data Services syntax does not start with `$`. Non-WCF Data Services query options can be added using this method. It is legal to add the same query option twice if the option is not an WCF Data Services query option. If a query option is added that is already present in the underlying URI, an exception is thrown.
## Examples
The following example shows a <xref:System.Data.Services.Client.DataServiceQuery%601> that is used with sequential <xref:System.Data.Services.Client.DataServiceQuery%601.AddQueryOption%2A> method calls to only return orders with a freight cost of more than $30 and to order the results by the ship date in descending order.
:::code language="csharp" source="~/snippets/csharp/System.Data.Services.Client/DataServiceCollectionT/Overview/source.cs" id="Snippetaddqueryoptions":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/source.vb" id="Snippetaddqueryoptions":::
The following example shows how to compose a LINQ query that is equivalent to the previous query that used <xref:System.Data.Services.Client.DataServiceQuery%601.AddQueryOption%2A>.
:::code language="csharp" source="~/snippets/csharp/System.Data.Services.Client/DataServiceCollectionT/Overview/source.cs" id="Snippetaddqueryoptionslinq":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/source.vb" id="Snippetaddqueryoptionslinq":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="BeginExecute">
<MemberSignature Language="C#" Value="public IAsyncResult BeginExecute (AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginExecute(class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.BeginExecute(System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginExecute (callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.BeginExecute : AsyncCallback * obj -> IAsyncResult" Usage="dataServiceQuery.BeginExecute (callback, state)" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginExecute(AsyncCallback ^ callback, System::Object ^ state);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="callback">The delegate to invoke when the operation completes.</param>
<param name="state">User defined object used to transfer state between the start of the operation and the callback defined by <paramref name="callback" />.</param>
<summary>Starts an asynchronous network operation that executes the query represented by this object instance.</summary>
<returns>An <see cref="T:System.IAsyncResult" /> that represents the status of the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ElementType">
<MemberSignature Language="C#" Value="public override Type ElementType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ElementType" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.Client.DataServiceQuery`1.ElementType" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property ElementType As Type" />
<MemberSignature Language="F#" Value="member this.ElementType : Type" Usage="System.Data.Services.Client.DataServiceQuery<'Element>.ElementType" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Type ^ ElementType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Linq.IQueryable.ElementType</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the type of the object used in the template to create the <see cref="T:System.Data.Services.Client.DataServiceQuery`1" /> instance.</summary>
<value>Returns <see cref="T:System.Type" /> representing the type used in the template when the query is created.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Gets the type represented by T in the generic methods: <xref:System.Data.Services.Client.DataServiceContext.CreateQuery%2A> or <xref:System.Data.Services.Client.DataServiceContext.CreateQuery%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EndExecute">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<TElement> EndExecute (IAsyncResult asyncResult);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<!TElement> EndExecute(class System.IAsyncResult asyncResult) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.EndExecute(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Function EndExecute (asyncResult As IAsyncResult) As IEnumerable(Of TElement)" />
<MemberSignature Language="F#" Value="override this.EndExecute : IAsyncResult -> seq<'Element>" Usage="dataServiceQuery.EndExecute asyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Generic::IEnumerable<TElement> ^ EndExecute(IAsyncResult ^ asyncResult);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<TElement></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="asyncResult">The pending asynchronous query request.</param>
<summary>Ends an asynchronous query request to a data service.</summary>
<returns>Returns an <see cref="T:System.Collections.Generic.IEnumerable`1" /> that contains the results of the query operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Data.Services.Client.DataServiceQueryException">When the data service returns an HTTP 404: Resource Not Found error.</exception>
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<TElement> Execute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<!TElement> Execute() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.Execute" />
<MemberSignature Language="VB.NET" Value="Public Function Execute () As IEnumerable(Of TElement)" />
<MemberSignature Language="F#" Value="override this.Execute : unit -> seq<'Element>" Usage="dataServiceQuery.Execute " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Generic::IEnumerable<TElement> ^ Execute();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<TElement></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes the query and returns the results as a collection that implements <see langword="IEnumerable" />.</summary>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> in which <paramref name="T" /> represents the type of the query results.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When iterating over the returned collection, if an object is encountered in the input stream that cannot be deserialized to an instance of `T` then a <xref:System.NotSupportedException> is thrown.
]]></format>
</remarks>
<exception cref="T:System.Data.Services.Client.DataServiceQueryException">When the data service returns an HTTP 404: Resource Not Found error.</exception>
</Docs>
</Member>
<Member MemberName="Expand">
<MemberSignature Language="C#" Value="public System.Data.Services.Client.DataServiceQuery<TElement> Expand (string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Data.Services.Client.DataServiceQuery`1<!TElement> Expand(string path) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.Expand(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function Expand (path As String) As DataServiceQuery(Of TElement)" />
<MemberSignature Language="F#" Value="member this.Expand : string -> System.Data.Services.Client.DataServiceQuery<'Element>" Usage="dataServiceQuery.Expand path" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Data::Services::Client::DataServiceQuery<TElement> ^ Expand(System::String ^ path);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Services.Client.DataServiceQuery<TElement></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">A string value that contains the requesting URI.</param>
<summary>Creates a new <see cref="T:System.Data.Services.Client.DataServiceQuery`1" /> with the expand option set in the URI generated by the returned query.</summary>
<returns>A new query that includes the requested <see langword="$expand" /> query option appended to the URI of the supplied query.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Expression">
<MemberSignature Language="C#" Value="public override System.Linq.Expressions.Expression Expression { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Linq.Expressions.Expression Expression" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.Client.DataServiceQuery`1.Expression" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Expression As Expression" />
<MemberSignature Language="F#" Value="member this.Expression : System.Linq.Expressions.Expression" Usage="System.Data.Services.Client.DataServiceQuery<'Element>.Expression" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Linq::Expressions::Expression ^ Expression { System::Linq::Expressions::Expression ^ get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Linq.IQueryable.Expression</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Linq.Expressions.Expression</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents an expression containing the query to the data service.</summary>
<value>A <see cref="T:System.Linq.Expressions.Expression" /> object representing the query.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerator<TElement> GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerator`1<!TElement> GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Public Function GetEnumerator () As IEnumerator(Of TElement)" />
<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -> System.Collections.Generic.IEnumerator<'Element>
override this.GetEnumerator : unit -> System.Collections.Generic.IEnumerator<'Element>" Usage="dataServiceQuery.GetEnumerator " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Collections::Generic::IEnumerator<TElement> ^ GetEnumerator();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.Generic.IEnumerable`1.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerator<TElement></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes the query and returns the results as a collection.</summary>
<returns>A typed enumerator over the results in which <paramref name="TEntity" /> represents the type of the query results.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the <xref:System.Data.Services.Client.DataServiceQuery%601.GetEnumerator%2A> method is called, the <xref:System.Data.Services.Client.DataServiceQuery%601> is executed against the service.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IncludeTotalCount">
<MemberSignature Language="C#" Value="public System.Data.Services.Client.DataServiceQuery<TElement> IncludeTotalCount ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Data.Services.Client.DataServiceQuery`1<!TElement> IncludeTotalCount() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.IncludeTotalCount" />
<MemberSignature Language="VB.NET" Value="Public Function IncludeTotalCount () As DataServiceQuery(Of TElement)" />
<MemberSignature Language="F#" Value="member this.IncludeTotalCount : unit -> System.Data.Services.Client.DataServiceQuery<'Element>" Usage="dataServiceQuery.IncludeTotalCount " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Data::Services::Client::DataServiceQuery<TElement> ^ IncludeTotalCount();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Services.Client.DataServiceQuery<TElement></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Requests that the count of all entities in the entity set be returned inline with the query results.</summary>
<returns>A new <see cref="T:System.Data.Services.Client.DataServiceQuery`1" /> object that has the inline count option set.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Calling the <xref:System.Data.Services.Client.DataServiceQuery%601.IncludeTotalCount%2A> method is equivalent to including the `$inlinecount` query option in the query URI.
## Examples
This example executes a query after it calls the <xref:System.Data.Services.Client.DataServiceQuery%601.IncludeTotalCount%2A> method. The <xref:System.Data.Services.Client.QueryOperationResponse%601.TotalCount%2A> property is used to determine number of entities returned by the query.
:::code language="csharp" source="~/snippets/csharp/System.Data.Services.Client/DataServiceCollectionT/Overview/source.cs" id="Snippetcountallcustomers":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/astoria_northwind_client/vb/source.vb" id="Snippetcountallcustomers":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Provider">
<MemberSignature Language="C#" Value="public override System.Linq.IQueryProvider Provider { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Linq.IQueryProvider Provider" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.Client.DataServiceQuery`1.Provider" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Provider As IQueryProvider" />
<MemberSignature Language="F#" Value="member this.Provider : System.Linq.IQueryProvider" Usage="System.Data.Services.Client.DataServiceQuery<'Element>.Provider" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Linq::IQueryProvider ^ Provider { System::Linq::IQueryProvider ^ get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Linq.IQueryable.Provider</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Linq.IQueryProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the query provider instance.</summary>
<value>A <see cref="T:System.Linq.IQueryProvider" /> representing the data source provider.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestUri">
<MemberSignature Language="C#" Value="public override Uri RequestUri { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri RequestUri" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.Client.DataServiceQuery`1.RequestUri" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property RequestUri As Uri" />
<MemberSignature Language="F#" Value="member this.RequestUri : Uri" Usage="System.Data.Services.Client.DataServiceQuery<'Element>.RequestUri" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Uri ^ RequestUri { Uri ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>Get the URI for the query.</summary>
<value>The URI of the request.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
<MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.System#Collections#IEnumerable#GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator" />
<MemberSignature Language="F#" Value="override this.System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator" Usage="dataServiceQuery.System.Collections.IEnumerable.GetEnumerator " />
<MemberSignature Language="C++ CLI" Value=" virtual System::Collections::IEnumerator ^ System.Collections.IEnumerable.GetEnumerator() = System::Collections::IEnumerable::GetEnumerator;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes the query and returns the results as a collection.</summary>
<returns>An enumerator over the query results.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the <xref:System.Data.Services.Client.DataServiceQuery%601.System%23Collections%23IEnumerable%23GetEnumerator%2A> method is called, the <xref:System.Data.Services.Client.DataServiceQuery%601> is executed against the service.
<xref:System.Data.Services.Client.DataServiceQuery%601.GetEnumerator%2A> returns an enumerable the first time it is called. On successive calls it returns null.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.Client.DataServiceQuery`1.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="dataServiceQuery.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services.Client</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Represents the URI of the query to the data service.</summary>
<returns>A URI as string that represents the query to the data service for this <see cref="T:System.Data.Services.Client.DataServiceQuery`1" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>